import { Document } from "mongoose"

// 表单 query 查询的类型集合
interface paramQuery {
  // 字段名称
  fieldName: string,
  // 字段类型
  fieldType: string,
  // 字段描述
  fieldDescription: string,
  // 字段示例
  fieldExample: string
}

export interface Interface extends Document {
  // 接口id
  _id?: string,
  // 接口名称
  name: string,
  // 分类id
  groupId?: string,
  // 接口描述
  description?: string,
  // 接口所属需求id
  demandId: string,
  // 接口请求方式
  method?: string,
  // 接口前缀
  prefix?: string,
  // 接口路径
  path?: string,
  // 入参类型  form json query
  paramType?: string,
  // 参数集合  query类型时传递的数据
  paramFormAndQueryList?: paramQuery[],
  // 参数实体  json类型时传递的数据
  paramPostBody?: object,
  // JSON5 源数据
  jsonSourceData?: string,
}